#pragma once
#include "stdafx.h"
//-------------------------------------------------------------------------------------------------
//ImageProcFn.h  - Declaration of an Image Processing Function (Step)           
//-------------------------------------------------------------------------------------------------
//FreeBSD License
//Copyright 2012 Will Stott All rights reserved.
//
//Redistribution and use in source and binary forms, with or without modification, are
//permitted provided that the following conditions are met:
//
//   1. Redistributions of source code must retain the above copyright notice, this list of
//      conditions and the following disclaimer.
//
//   2. Redistributions in binary form must reproduce the above copyright notice, this list
//      of conditions and the following disclaimer in the documentation and/or other materials
//      provided with the distribution.
//
//THIS SOFTWARE IS PROVIDED BY Will Stott ``AS IS'' AND ANY EXPRESS OR IMPLIED
//WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Will Stott OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//The views and conclusions contained in the software and documentation are those of the
//authors and should not be interpreted as representing official policies, either expressed
//or implied, of Will Stott.
//
//----Authors--------------------------------------------------------------------------------------
//created by: will.stott@ucl.ac.uk Feb 2012
//
//----Comments-------------------------------------------------------------------------------------
//
//-------------------------------------------------------------------------------------------------
#ifdef PLUGINICPROCSTEPS_EXPORTS
#define PLUGINICPROCSTEPS_API __declspec(dllexport)
#else
#define PLUGINICPROCSTEPS_API __declspec(dllimport)
#endif

#include <string>

#include "ProcParamsInputs.h"
#include "ProcParamsOutputs.h"
#include "ProcParamDef.h"
#include "ProcParamsDefs.h"
#include "IImageProcFn.h"

class PLUGINICPROCSTEPS_API ImageProcFn
{
friend class ImageProcStepLibAuto;
public:
	static const char * const ImageProcFn::BadName;
	static const char * const ImageProcFn::BadDescription;
	static const int		  ImageProcFn::Invalid = -1;

public:
	ImageProcFn(void);
	ImageProcFn(ImageProcFn *def);
	virtual ~ImageProcFn(void);

	bool			  AddParamDef(ProcParamDef *param); 

	bool			  SetFunctionName(const char *Name);
	const char       *GetFunctionName() { return (IsValid() ?  _functionName.c_str() : ImageProcFn::BadName); }
	bool			  SetFunctionDescription(const char *Text);
	const char       *GetFunctionDescription() { return (IsValid() ? _functionDescription.c_str() : ImageProcFn::BadDescription); }

	int				  GetParamDefCnt(IPluginICProcStepsParamDef::Direction dir);
	ProcParamDef    * GetParamDef(int index, IPluginICProcStepsParamDef::Direction dir);

	bool			  IsMatch(const char *FunctionName, ProcParamsOutputs *outputs, ProcParamsInputs *inputs);
	bool			  Validate();
	bool			  IsValid() { return ( (_error == false) ? true: false); }
	bool			  IsAnalysisFn () { return _AnalysisFn; }

	bool			  SaveFunctionDefToXml(void *xmlStep);	

private:
	void			  UpdateFunctionDescriptionForAnalysis();
private:
	bool			_error;
	bool			_AnalysisFn;
#pragma warning(disable:4251)
	std::string _functionName;
	std::string _functionDescription;
#pragma warning(default:4251)
	ProcParamsDefs   _params;

};

//-------------------------------------------------------------------------------------------------
//			E N D   O F   F I L E
//-------------------------------------------------------------------------------------------------

